home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / doc / libept0 / README < prev   
Text File  |  2008-06-27  |  2KB  |  66 lines
  1. README for ept
  2. ==============
  3.  
  4. The intent of this library is to provide high-level access to all sorts of
  5. sources of information about Debian packages.
  6.  
  7. There are four data providers currently implemented:
  8.  
  9.  - APT: access the APT database
  10.  - Debtags: access the Debtags tag information
  11.  - Popcon: access Popcon package scores
  12.  - TextSearch: fast Xapian-based full text search on package description
  13.  
  14. To enable the popcon data provider, just download the file
  15. http://popcon.debian.org/all-popcon-results.txt.gz and put it into
  16. /var/lib/popcon/ or ~/.popcon/ in the user's home directory.
  17.  
  18. To enable the xapian fast search index, run ept-cache reindex as root.
  19.  
  20. The xapian index is not regenerated automatically like with popcon and debtags
  21. because it takes a while to build.  It is also not stored in the user's home
  22. directory because it is quite large.
  23.  
  24.  
  25. Development
  26. ===========
  27.  
  28. The library revolves around two classes: Package and Version.  These classes
  29. represent a package or one of its specific versions.  Using these classes it is
  30. possible to query one or more data providers for information about the package.
  31.  
  32. The idea is to have a way to represent a package or one of its versions, and
  33. that this way must be valid for any data provider.
  34.  
  35. A data provider does not need to know about the others, nor it needs to
  36. implement a specific interface: the only requirement on a data provider is that
  37. it can be queried using Package and Version objects, as appropriate.
  38.  
  39. It is easy to implement more data providers.  It is also easy to implement new
  40. data providers outside of this library, as long as they can be queried using
  41. Package or Version objects.
  42.  
  43. The 4 providers are currently shipped with the library to avoid having a chain
  44. of dependencies on the initial state of the project.  It is straightforward,
  45. however, to package them separately from the core Package infrastructure.
  46.  
  47.  
  48. The development of libept is currently published in the Mercurial repository
  49. at: http://hg.debian.org/hg/private/enrico/libept
  50.  
  51. It is possible to checkout a copy of the repository with the command:
  52.  
  53.   hg clone http://hg.debian.org/hg/private/enrico/libept
  54.  
  55. Mercurial is a distributed version control system: you are encouraged to play
  56. with the code, join the development and publish your Mercurial tree.
  57.  
  58.  
  59. Authors
  60. =======
  61.  
  62. Enrico Zini <enrico@enricozini.org>
  63.  
  64. Some code is ported to the Package framework from libept, written by Peter
  65. Rockai <me@mornfall.net> and Enrico Zini <enrico@enricozini.org>
  66.